﻿using System;
using System.Collections.Generic;
using System.Text;

namespace Workflows.Components.TextMining.Clustering
{
    /// <summary>
    /// 
    /// </summary>
    [Serializable]
    public class SupervisedClusteringInstruction
    {
        #region props
        private string _CategoryListFilePath;
        /// <summary>
        /// hierarchical list of categories (document labels)
        /// <Categories>
        ///     <Category CategoryID="0" CategoryName="" ParentCategoryID=""/>
        /// </Categories>
        /// </summary>
        public string CategoryListFilePath
        {
            get
            {
                return this._CategoryListFilePath;
            }
            set
            {
                this._CategoryListFilePath = value;
            }
        }

        private string _TrainingDocumentListFilePath;
        /// <summary>
        /// xml document mapping doc to category 
        /// category can be nested (hierarchical)
        /// <Docs>
        ///     <Doc DocID="0" CategoryID="0"/>
        /// </Docs>
        /// </summary>
        public string TrainingDocumentListFilePath
        {
            get
            {
                return this._TrainingDocumentListFilePath;
            }
            set
            {
                this._TrainingDocumentListFilePath = value;
            }
        }

        private string _DeterminativeFeatureSetFilePath;
        /// <summary>
        /// xml file containing a set of terms (feature set) that 
        /// help classify documents to predefined categories (labels)
        /// term score can be both positive and negative
        /// <FeatureSet>
        ///     <Category CategoryID="0" ThresholdScore="0.500">
        ///         <Term TermID="0" Weight="0.45"/>
        ///     </Category>
        /// </FeatureSet>
        /// </summary>
        public string DeterminativeFeatureSetFilePath
        {
            get
            {
                return this._DeterminativeFeatureSetFilePath;
            }
            set
            {
                this._DeterminativeFeatureSetFilePath = value;
            }
        }
        #endregion


    }
}
